chore: add zod2md-nx-plugin #1162

BioPhoton · 2025-12-02T23:20:13Z

Followup of #1163
Precondition of #1188

This PR includes:

create nx plugin under zod2md-jsdocs
logic to add target config if file matches zod2md.config.ts
plugin docs
remove old config
remove file reference from production inputs as changes in the config may impact build output

A potential followup PR could implement a nx plugin for our build target and add dependsOn settings automatically. This is also noted in a clean up issue.

Note

This is tooling code and it is not planned to get released

Related:
#1168

nx-cloud · 2025-12-02T23:21:35Z

View your CI Pipeline Execution ↗ for commit d1eb4f8

Command	Status	Duration	Result
`nx run ci:code-pushup -- merge-diffs --files=/h...`	✅ Succeeded	5s	View ↗
`nx run-many --targets=code-pushup --parallel=fa...`	✅ Succeeded	1m 37s	View ↗
`nx run-many --targets=code-pushup --parallel=fa...`	✅ Succeeded	13m 20s	View ↗
`nx run-many -t unit-test,int-test`	✅ Succeeded	53s	View ↗

☁️ Nx Cloud last updated this comment at 2026-01-16 22:46:33 UTC

pkg-pr-new · 2025-12-02T23:21:53Z

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1162

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1162

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1162

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1162

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1162

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1162

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1162

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1162

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1162

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1162

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1162

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1162

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1162

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1162

commit: d1eb4f8

github-actions · 2025-12-02T23:28:36Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 543447a with previous commit 270b474.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🔴 37	🔴 39
Code style	🟢 99	🟢 100
Code coverage	🟢 93	🟢 92
Bug prevention	🟡 75	🟡 75
Axe Accessibility	🟡 88	🟡 88
Security	🟡 51	🟡 51	–
Updates	🟡 78	🟡 78	–
Type Safety	🟡 67	🟡 67	–
Miscellaneous	🟡 67	🟡 67	–
Documentation	🔴 42	🔴 42	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟢 92	🟢 92	–

👍 3 groups improved, 👎 1 group regressed, 👍 6 audits improved, 👎 3 audits regressed, 14 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score
ESLint	Style guide (import)	🟡 80	🟢 100
Lighthouse	Performance	🔴 37	🔴 39
ESLint	Suggestions	🟢 99	🟢 100
Code coverage	Code coverage metrics	🟢 93	🟢 92

30 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
ESLint	Forbid unassigned imports	🟥 1 warning	🟩 passed
Lighthouse	Total Blocking Time	🟥 1,890 ms	🟥 1,480 ms
Lighthouse	Speed Index	🟥 6.0 s	🟥 5.8 s
Lighthouse	Time to Interactive	🟥 13.0 s	🟥 12.6 s
Lighthouse	First Contentful Paint	🟥 3.1 s	🟥 3.0 s
Lighthouse	Max Potential First Input Delay	🟥 980 ms	🟥 720 ms
Code coverage	Line coverage	🟩 92.7 %	🟩 92.3 %
Code coverage	Function coverage	🟩 94.4 %	🟩 94.3 %
Code coverage	Branch coverage	🟨 89 %	🟨 89 %
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,104 KiB	🟩 Total size was 2,106 KiB
Lighthouse	Minimizes main-thread work	🟥 9.2 s	🟥 7.6 s
Lighthouse	Largest Contentful Paint	🟥 11.5 s	🟥 10.9 s
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	JavaScript execution time	🟥 4.3 s	🟥 3.8 s
Lighthouse	Server Backend Latencies	🟩 1,200 ms	🟩 770 ms
Lighthouse	Uses efficient cache policy on static assets	🟨 31 resources found	🟨 31 resources found
Lighthouse	Reduce unused CSS	🟥 Potential savings of 95 KiB	🟥 Potential savings of 95 KiB
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 224 KiB	🟥 Potential savings of 225 KiB
Lighthouse	Initial server response time was short	🟩 Root document took 540 ms	🟩 Root document took 510 ms
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 93 KiB	🟥 Potential savings of 90 KiB
Lighthouse	Network Round Trip Times	🟩 10 ms	🟩 20 ms
JS packages	Outdated npm prod dependencies.	🟨 16 outdated package versions (5 major, 8 minor, 3 patch)	🟨 15 outdated package versions (5 major, 8 minor, 2 patch)
JS packages	Outdated npm dev dependencies.	🟨 56 outdated package versions (29 major, 19 minor, 8 patch)	🟨 55 outdated package versions (29 major, 18 minor, 8 patch)

656 other audits are unchanged.

github-actions · 2025-12-02T23:35:22Z

Code PushUp

😟 Code PushUp report has regressed – compared current commit 543447a with previous commit 270b474.

💼 Project `utils`

😟 Code PushUp report has regressed.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Documentation	🔴 45	🔴 45

5 other categories are unchanged.

👎 1 group regressed

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
JSDocs coverage	Documentation coverage	🔴 45	🔴 45

14 other groups are unchanged.

🛡️ Audits

All of 444 audits are unchanged.

13 other projects are unchanged.

tools/zod2md-nx-plugin/package.json

tools/zod2md-nx-plugin/eslint.config.js

tools/zod2md-nx-plugin/README.md

tools/zod2md-nx-plugin/src/lib/plugin.js

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

tools/zod2md-jsdocs/src/nx-plugin.js

…lugin

BioPhoton · 2025-12-16T00:44:20Z

After switching to .ts format for the Nx plugin, the graph stopped computing because of NX invalid type: unit value, expected struct Options.
I researched and found out package updates help so I updated nx packages.

After the update errors popped up that i could not fully relate to the changes:

@matejchalk could you check this changes pls.

# Conflicts: # package-lock.json # package.json

# Conflicts: # packages/plugin-eslint/src/lib/eslint-plugin.int.test.ts

BioPhoton · 2026-01-05T23:47:59Z

I was able to resolve the same issue in NX v22 without changed in tests. (related: #1162 (comment))

tools/zod2md-jsdocs/docs/zod2md-jsdocs-nx-plugin.md

matejchalk · 2026-01-13T17:52:06Z

tools/zod2md-jsdocs/src/lib/transformers.ts

 }

-module.exports = annotateTypeDefinitions;
+export { annotateTypeDefinitions as default };


I don't think you're using the default export anymore.

Suggested change

export { annotateTypeDefinitions as default };

The only reference to this module is in index.ts, which uses a named import.

cli/tools/zod2md-jsdocs/src/index.ts

Lines 1 to 8 in 2ac556a

import { annotateTypeDefinitions } from './lib/transformers.js';

export {

annotateTypeDefinitions,

generateJSDocComment,

} from './lib/transformers.js';

export default annotateTypeDefinitions;

tools/zod2md-jsdocs/package.json

matejchalk · 2026-01-13T18:06:24Z

packages/models/project.json

        "generate-docs",
-        { "projects": "zod2md-jsdocs", "target": "build" }
+        { "projects": "zod2md-jsdocs", "target": "build" },
+        { "projects": "zod2md-jsdocs", "target": "ts-patch" }


Is it necessary to add these dependencies manually? Couldn't the plugin infer them based on the existence of zod2md.config.ts? It's looking like a leaky abstraction at the moment.

I thought I will automate this part in: #1188 (followup of this one).
What I already did is considering the cleanest solution..
ATM I believe I will:

implement a sync generator to

do the ts config file update of the TS transformer based on the presence of zod2md.config.ts

do the build target implementation either in a plugin, or move the docs build step into sync generator

As my opinion could change when starting to clean up build config i thought I keep that part out in this PR.

John Doe added 5 commits December 2, 2025 23:00

refactor: move models-transformers into tools

867c80d

refactor: add zod2md-nx-plugin

594f451

refactor: wip

00256ee

refactor: adjust plugin code

9112bf0

refactor: wip

c7882cb

github-actions bot assigned BioPhoton Dec 2, 2025

github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🛠️ tooling labels Dec 2, 2025

John Doe added 4 commits December 3, 2025 00:24

refactor: wip

1cf9a7a

refactor: wip

12a12d5

refactor: wip

4d629f4

refactor: wip

fb004e1

BioPhoton marked this pull request as ready for review December 2, 2025 23:41

BioPhoton requested a review from matejchalk December 2, 2025 23:41

BioPhoton added the 🧹 maintenance label Dec 2, 2025

matejchalk requested changes Dec 3, 2025

View reviewed changes

BioPhoton and others added 7 commits December 3, 2025 16:20

Update tools/zod2md-nx-plugin/eslint.config.js

8253323

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

Update tools/zod2md-nx-plugin/README.md

670b232

Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>

refactor: wip

a4cf4b9

refactor: wip

b02a6a0

refactor: wip

4d6c335

refactor: wip

ce500c7

Merge branch 'main' into chore/add-zod2md-nx-plugin

1a158f1

matejchalk reviewed Dec 4, 2025

View reviewed changes

tools/zod2md-jsdocs/src/nx-plugin.js Outdated Show resolved Hide resolved

BioPhoton mentioned this pull request Dec 4, 2025

chore: move transformers to new project #1163

Merged

Merge remote-tracking branch 'origin/main' into chore/add-zod2md-nx-p…

25c79f4

…lugin

John Doe added 8 commits December 15, 2025 23:10

refactor: wip

0064e04

refactor: wip

f918b5c

refactor: lock versions

918fa8d

refactor: revert lock versions

e5b8c2c

refactor: update nx versions

34eed75

refactor: update nx versions 2

c9d546d

refactor: update nx versions 2

3fc54f6

refactor: fix Nx update

ff6c610

github-actions bot added the 🧩 eslint-plugin label Dec 16, 2025

refactor: fix Nx update unit tests

fa94f93

github-actions bot added the 🧩 models label Dec 16, 2025

refactor: fix Nx update lint

e88d62d

BioPhoton requested a review from matejchalk December 16, 2025 01:09

John Doe added 3 commits January 6, 2026 00:11

Merge branch 'main' into chore/add-zod2md-nx-plugin

9e60d56

# Conflicts: # package-lock.json # package.json

refactor: fix Binding issue in Nx v22

813244e

Merge branch 'main' into chore/add-zod2md-nx-plugin

d45247f

# Conflicts: # packages/plugin-eslint/src/lib/eslint-plugin.int.test.ts

github-actions bot removed the 🧩 eslint-plugin label Jan 5, 2026

refactor: revert changes, build models

57bf0e6

github-actions bot removed the 🧩 models label Jan 5, 2026

BioPhoton disabled auto-merge January 6, 2026 03:36

John Doe added 2 commits January 6, 2026 19:01

refactor: fix pkgs

67d321e

Merge branch 'main' into chore/add-zod2md-nx-plugin

2ac556a

BioPhoton requested a review from hanna-skryl January 7, 2026 22:24

hanna-skryl reviewed Jan 9, 2026

View reviewed changes

tools/zod2md-jsdocs/docs/zod2md-jsdocs-nx-plugin.md Outdated Show resolved Hide resolved

matejchalk requested changes Jan 13, 2026

View reviewed changes

BioPhoton added 3 commits January 16, 2026 23:23

Merge branch 'main' into chore/add-zod2md-nx-plugin

a11c62c

refactor: fix docs

87635c2

refactor: wip

d1eb4f8

	import { annotateTypeDefinitions } from './lib/transformers.js';

	export {
	annotateTypeDefinitions,
	generateJSDocComment,
	} from './lib/transformers.js';

	export default annotateTypeDefinitions;

chore: add zod2md-nx-plugin #1162

Are you sure you want to change the base?

chore: add zod2md-nx-plugin #1162

Uh oh!

Conversation

BioPhoton commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

🏷️ Categories

🗃️ Groups

🛡️ Audits

Uh oh!

github-actions bot commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

💼 Project utils

🗃️ Groups

🛡️ Audits

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BioPhoton commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BioPhoton commented Jan 5, 2026

Uh oh!

Uh oh!

matejchalk Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matejchalk Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

BioPhoton Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BioPhoton commented Dec 2, 2025 •

edited

Loading

nx-cloud bot commented Dec 2, 2025 •

edited

Loading

pkg-pr-new bot commented Dec 2, 2025 •

edited

Loading

github-actions bot commented Dec 2, 2025 •

edited

Loading

github-actions bot commented Dec 2, 2025 •

edited

Loading

💼 Project `utils`

BioPhoton commented Dec 16, 2025 •

edited

Loading

BioPhoton Jan 13, 2026 •

edited

Loading